home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / syncrnet / sc19.zip / SC.ZIP / SYNCCHAT.DOC < prev    next >
Text File  |  1996-04-27  |  17KB  |  383 lines
  1. ╓─────┐ ╥  ┬ ╓──┐ ╓──┐ ╓─────┐ ╥  ┬ ╓──┐ ╓─╥─┐   v1.9
  2. ║       ╙──┤ ║  │ ║    ║       ╟──┤ ╟──┤   ║
  3. ╙─────┐ ╙──┘ ╨  ┴ ╙──┘ ║       ╨  ┴ ╨  ┴   ╨
  4.       │                ║
  5. ╙─────┘                ╙─────┘      D O C U M E N T A T I O N
  6.                                     -------------------------
  7.  
  8. Copyright (C) 1995, 1996 Garry C. Dolley (AKA Prophet)
  9.                          Ryan C. Dodd (AKA Etherius)
  10. All other products copyright of their respective companies
  11. Documentation written by Prophet.
  12.  
  13. "The ULTIMATE in teleconferencing doors for Synchronet!"
  14.  
  15.  
  16. ┌─────────────────┐
  17. │ F E A T U R E S │
  18. └─────────────────┘
  19.  
  20. » You get a cool installation program.  Makes installing easy. :)
  21.  
  22. » You get a configuration program so you don't have to edit any text files to
  23.   change your configuration, edit strings, add IGMs, etc...
  24.  
  25. » An advanced Action system.  Users can see what an action will look like
  26.   before they use it (Ex: "HF HELP" or "HUG HELP").  Actions are easily edited
  27.   by the SyncChat Configuration Editor and compatible with the Renegade
  28.   ACTIONS.LST format.
  29.  
  30. » Every string displayed by SyncChat can be edited with the easy to use
  31.   SyncChat Configuration Editor, no need to hassle with text files.  This
  32.   allows you to configure SyncChat to the look and feel you wish to obtain.
  33.  
  34. » Games!  Games!  Games! :)
  35.   Games can be installed into SyncChat so users can have very easy access to
  36.   games they'd like to play.  They won't have to exit SyncChat and go to the
  37.   online games menu to run a game.  Other users in SyncChat will be notified
  38.   of which users are playing the games, so those users can join in if they'd
  39.   like!
  40.  
  41. » SyncChat supports multiple channels.  Each user gets their own private
  42.   channel to talk privately to whomever they wish.  Each user can also join
  43.   multiple sysop definable public channel to talk publicly to everyone else.
  44.  
  45. » Each channel can have it's own topic.  For private channels, only the owner
  46.   of the private channel can change the topic, and for the public channels,
  47.   anyone can change the topic.
  48.  
  49. » Each channel can have it's own different set of actions.
  50.  
  51. » SyncChat supports the popular ">" and "/" direction/whisper commands.  If
  52.   you have used the MBBS (Worldgroup) teleconference, you probably are
  53.   already familier with these.  These commands come in very handy when
  54.   chatting with more than two people.
  55.  
  56. » Whispers (private messages sent with the "/" command) can be seen by anyone
  57.   with a SL of 90 or higher.
  58.  
  59. » When using commands such as "/", ">", or issuing an action, users only need
  60.   to type the first THREE letters of the persons handle to which they are
  61.   directing the command.  For example, to use the HIGHFIVE action and direct
  62.   it to Prophet, they just need to type "HIGHFIVE PRO" not "HIGHFIVE PROPHET".
  63.   This comes in very handy and is a great help to the people who don't like to
  64.   type in long user names (or even short ones ;).
  65.  
  66. » The default help and actions help displays can be customized by two .ASC
  67.   and/or .ANS files (see below).
  68.  
  69. » SyncChat works hand in hand with SyncRegistry so you can offer a complete
  70.   user registry to your users, and your users can look-up profiles while
  71.   they are chatting!
  72.  
  73. » A RAM drive is supported and recommended as a temporary/swapping directory
  74.   to increase the speed of SyncChat and the rest of the BBS.
  75.  
  76. » SyncChat has a strong MBBS feel to it.  It was designed this way so
  77.   Synchronet sysops could run this type of teleconference without having to
  78.   spend a billion dollars running and maintaning a MajorBBS board (oh now
  79.   watch me get sued...)
  80.  
  81.  
  82. ┌───────────────────────────────────────┐
  83. │ I N S T A L L A T I O N   S A M P L E │
  84. └───────────────────────────────────────┘
  85.  
  86. In case you need to see how to configure SyncChat in SCFG again, here's the
  87. sample:
  88.  
  89.           ╔[■][?]════════════════════════════════════════════════════╗
  90.           ║                         SyncChat                         ║
  91.           ╠══════════════════════════════════════════════════════════╣
  92.           ║ │Name                       SyncChat                     ║
  93.           ║ │Internal Code              SYNCCHAT                     ║
  94.           ║ │Start-up Directory         ..\XTRN\SYNCCHAT             ║
  95.           ║ │Command Line               SYNCCHAT.EXE                 ║
  96.           ║ │Clean-up Command Line                                   ║
  97.           ║ │Execution Cost             None                         ║
  98.           ║ │Access Requirements                                     ║
  99.           ║ │Execution Requirements                                  ║
  100.           ║ │Multiple Concurrent Users  Yes                          ║
  101.           ║ │Intercept I/O Interrupts   Yes                          ║
  102.           ║ │Swap BBS out of Memory     Yes                          ║
  103.           ║ │Modify User Data           No                           ║
  104.           ║ │Execute on Event           No                           ║
  105.           ║ │BBS Drop File Type         Synchronet      XTRN.DAT     ║
  106.           ║ │Place Drop File In         Node Directory               ║
  107.           ║ │Time Options...                                         ║
  108.           ╚══════════════════════════════════════════════════════════╝
  109.  
  110.  
  111. ┌───────────────────────────┐
  112. │ C O N F I G U R A T I O N │
  113. └───────────────────────────┘
  114.  
  115. Configuration of SyncChat is extremely easy.  Just type SCONFIG when you're
  116. in your SyncChat directory.  An explanation of each command follows:
  117.  
  118.  
  119. BBS Name, SysOp Name, Registration Code, and Temporary Directory
  120. ----------------------------------------------------------------
  121. Duh ;)  Fill these options out accordingly.  If you have not registered, you
  122. may put a 0 as your registration code.  Note: When specifying the temporary
  123. directory, the directory name MUST NOT CONTAIN NUMBERS.  Also Note: The
  124. temporary directory is optional.  If you don't edit it, it will default to
  125. the main SyncChat directory.  Remember, it is recommended that you use a RAM
  126. drive as a temporary directory.  It will increase the speed of SyncChat and
  127. the rest of your BBS.
  128.  
  129.  
  130. The IGM Editor
  131. --------------
  132. IGM stands for In Game Module.  Even though SyncChat is not a game, we chose
  133. the name IGM because of Seth Able's LORD.  I mean, why invent a new ancronym
  134. (ITM - In Teleconference Module??), when games for SyncChat install and
  135. behave much like IGMs in LORD?
  136. IGM names may contain CTRL-A codes for you colorful people. :)  The IGM data
  137. file, GAMES.DAT, has the same format as LORD's 3RDPARTY.DAT.  For those of
  138. you not familier with that format, here it is:
  139.  
  140. [PATH AND FILENAME OF EXECUTABLE]
  141. [IGM NAME]
  142.  
  143. The PATH AND FILENAME line may contain a '*' which will translate into the
  144. node number of the node SyncChat is currently running on.  Here's an example:
  145.  
  146. ---------- [Begin GAMES.DAT] -----------
  147. C:\SBBS\XTRN\SBJ\SBJ.BAT *               
  148. Synchronet BlackJack!
  149. C:\SBBS\XTRN\DPOKER\DPOKER.EXE
  150. Domain Poker
  151. ---------- [ End GAMES.DAT ]------------
  152.  
  153. WARNING: DO NOT SPECIFY A PATH OR FILENAME THAT DOES NOT EXIST, UNEXPECTED
  154. OPERATION WILL RESULT!
  155.  
  156. Only doors specifically made for Synchronet can be run as IGMs.  Doors such
  157. as: Sychronet BlackJack, Domain Poker, and Synchronet Lottery will all work
  158. fine.  Door games not specifically made for Synchronet, such as LORD or
  159. BRE, WILL NOT WORK.  Do not try to run them as IGMs.
  160.  
  161.  
  162. The String Editor
  163. -----------------
  164. This is easy and self-explanatory. :)  Simply choose the string you'd like to
  165. edit and proceed to enter in the new string.  You may use CTRL-A codes for
  166. color and each string may be up to 160 characters in length.  Special Note:
  167. Be sure to keep the same amount of "%" codes in the original string as in the
  168. new string.  Just like Synchronet's TEXT.DAT.
  169.  
  170.  
  171. The Actions Editor
  172. ------------------
  173. When you first enter the Actions Editor, you are asked for what Actions File
  174. you want to edit.  This lets you have multiple action files.  Why would you
  175. want to have more than one action file?  Well, each channel can have it's
  176. own set of actions (See "The Channel Editor" section).  If you only want or
  177. need one action file, just press ENTER, and the default actions file
  178. (ACTIONS.LST) will be used.  The format for any actions file is as follows:
  179.  
  180.  
  181. [ACTION WORD]                                        <-- 12 chars max
  182. [STRING SHOWN TO USER - "RESPONSE"]                  <-- 128 chars max
  183. [STRING SHOWN TO ALL BUT RECIEVER]                   <-- 128 chars max
  184. [STRING SHOWN IF THERE IS NO RECIEVER]               <-- 128 chars max
  185. [STRING SHOWN TO RECIEVER]                           <-- 128 chars max
  186.  
  187.  
  188. This file can be edited manually, but it's much easier to use this editor.
  189. Two codes can be used for the "Sender" and "Reciever".  They are both "%s".
  190. The first "%s" in the string is always the sender, and the second "%s" is
  191. the reciever.  Another code, "~s~", will be replaced by "him" or "her"
  192. depending on the sex of the sender of the action.  None of these codes need
  193. to be used in the string.  A sample ACTIONS.LST follows:
  194.  
  195. ---------- [Begin ACTIONS.LST] -----------
  196. HF
  197. ...BAM!
  198. %s just gave %s a high five!!
  199. %s gave EVERYONE a high five!!
  200. %s gave YOU a high five!!
  201. LAUGH
  202. ...HAHAHAHAHAH.....
  203. %s is laughing at %s!
  204. %s is laughing his fool head off!!
  205. %s is laughing at you!
  206. SUICIDE
  207. ...You're history, bub...
  208. %s killed ~s~self!                               <-- Note the "~s~" codes.
  209. %s killed ~s~self!                                   They will translate into
  210. %s killed ~s~self!                                   "him" or "her".
  211. ---------- [ End ACTIONS.LST ] -----------
  212.  
  213.  
  214.  
  215. The Channel Editor
  216. ------------------
  217. This one is pretty self-explanatory ;)  Each channel name can be up to 80
  218. characters in length and you can use CTRL-A codes for color.  The "Min. SL"
  219. column lists the minimum security level value needed to enter the
  220. corresponding channel.  The "Actions File" section lists what actions file
  221. is used for the corresponding channel.  This lets each channel have it's own
  222. set of actions.  If you just want each channel to use the same set of
  223. actions, you can set this field to "ACTIONS.LST".
  224.  
  225.  
  226. Toggles
  227. -------
  228. Here's a long description of each of the toggle-able options:
  229.  
  230. * Delete Topic If Everyone Leaves A Channel
  231.   If this option is set to "Yes", if every user leaves a certain channel, the
  232.   current topic will be deleted.  If this is set to "No", then the topic for
  233.   public channels is not deleted until someone overwrites the current one.
  234. * Delete Prompt Before Displaying Messages
  235.   If this option is set to "Yes", the current prompt (Usually a ":") will be
  236.   deleted before a message is displayed.  This is a 'cleaner' mode to work
  237.   with.  More messages will also fit on a screen at a time.  Just try it and
  238.   see if you like it :)
  239.  
  240.  
  241. Kick Users Who Are "Stuck" In SyncChat
  242. --------------------------------------
  243. If you ever see that SyncChat reports that someone is in chat but they are
  244. really not, choose this option and the user(s) will be "kicked off".
  245. NOTE! SYNCCHAT MUST NOT BE RUNNING FOR THIS OPTION TO WORK PROPERLY.
  246.  
  247.  
  248. Optional Files
  249. --------------
  250. Instead of SyncChat displaying the default 'menus', you can use optional
  251. files to display your own custom versions of these menus.  Here's a list
  252. of these optional files:
  253.  
  254. HELP.*                        Main Help Options.  What user sees when they
  255.                               press "?" in SyncChat.
  256. ACTHELP.*                     Actions List and Help.  What user sees when
  257.                               they press "A" in SyncChat.
  258.  
  259. The "*" can be .ASC or .ANS (i.e. HELP.ANS or HELP.ASC).
  260. The .ASC version can contain CTRL-A codes or no codes at all.  The .ANS
  261. version can contain ANSI codes.  The .ANS version will be displayed to ANSI
  262. callers, and the .ASC version to non-ANSI callers.  If you don't have an
  263. .ANS version, the corresponding .ASC version will be displayed.  These
  264. files should be located in the main SyncChat directory.
  265.  
  266.  
  267. ┌─────────────────────────┐
  268. │ S Y N C R E G I S T R Y │
  269. └─────────────────────────┘
  270.  
  271. SyncRegistry is included with the SyncChat archive.  SyncRegistry is an
  272. external program (SYNCREG.EXE) that SyncChat calls whenever your users want
  273. to enter the Registry.  Since it is an external program, you may wish to
  274. let your users have access to it OUTSIDE of SyncChat (i.e. At Logon).
  275. Here are the proper settings in SCFG for SyncRegistry:
  276.  
  277.  
  278.           ╔[■][?]════════════════════════════════════════════════════╗
  279.           ║                       SyncRegistry                       ║
  280.           ╠══════════════════════════════════════════════════════════╣
  281.           ║ │Name                       SyncRegistry                 ║
  282.           ║ │Internal Code              SYNCREG                      ║
  283.           ║ │Start-up Directory         C:\SBBS\XTRN\SYNCCHAT        ║
  284.           ║ │Command Line               SYNCREG.EXE                  ║
  285.           ║ │Clean-up Command Line                                   ║
  286.           ║ │Execution Cost             None                         ║
  287.           ║ │Access Requirements                                     ║
  288.           ║ │Execution Requirements                                  ║
  289.           ║ │Multiple Concurrent Users  Yes                          ║
  290.           ║ │Intercept I/O Interrupts   Yes                          ║
  291.           ║ │Swap BBS out of Memory     Yes                          ║
  292.           ║ │Modify User Data           No                           ║
  293.           ║ │Execute on Event           No                           ║
  294.           ║ │BBS Drop File Type         Synchronet      XTRN.DAT     ║
  295.           ║ │Place Drop File In         Node Directory               ║
  296.           ║ │Time Options...                                         ║
  297.           ╚══════════════════════════════════════════════════════════╝
  298.  
  299. Let it be known that SyncRegistry comes with COMPLETE 'C' SOURCE CODE!!!
  300. Refer to SYNCREG.C and MAKEFILE in your SyncChat directory.
  301. Refer to SYNCREG.DOC for full documentation.
  302.  
  303.  
  304. ┌─────────────────────────┐
  305. │ R E G I S T R A T I O N │
  306. └─────────────────────────┘
  307.  
  308. The Unregistered version of SyncChat will allow a user to stay in chat for
  309. only 10 minutes, then he/she will be kicked out.  They may, however, go back
  310. into SyncChat.  There is also a limit of two IGMs that can be configured.
  311. Registration will get rid of these limitations.  It also helps Etherius and
  312. I (Prophet) make upgrades and deliver a better product.  Registration is a
  313. one time process, so upgrades are FREE!  It only costs $25.  Refer to the
  314. ORDER.TXT file included with this archive to register your copy of SyncChat.
  315. Thanks for your support!
  316.  
  317.  
  318. ┌─────────────────────────┐
  319. │ T H A N K S  T O . . .  │
  320. └─────────────────────────┘
  321.  
  322. Thanks to our beta sites:
  323.  
  324.   The O-Zone BBS (810-651-6472) [SysOp: Tom Fotherby]
  325.   Planet Reisa BBS (1:311/22) [SysOp: Barbara Anderson]
  326.   The DockSide BBS (1:2602/0) [SysOp: Danny Cook]
  327.   FlashPoint (1:139/635) [SysOp: Jon Verrett]
  328.   The Game Room BBS (1:2201/11) [SysOp: Bill Cronkhite]
  329.  
  330. Thanks to Korrupt for letting me steal some of his actions ;)
  331. (Exodus Crossroads - 213-756-4167 or 213-756-7381)
  332.  
  333. Thanks to enigma of The O-Zone for writing the CHAT.SRC module!
  334.  
  335. Thanks to Rob for making XSDK, so us programmers could play with it :)
  336.  
  337. and...
  338.  
  339. Thanks to all of Digital Dynamics for making Synchronet, the best BBS
  340. software ever!
  341.  
  342.  
  343. ┌─────────────────────────────────────────────────────────────────────┐
  344. │ T E C H N I C A L   S U P P O R T   A N D   D I S T R I B U T I O N │
  345. └─────────────────────────────────────────────────────────────────────┘
  346.  
  347. SyncChat Home BBSs:
  348.  
  349.   Dragonspear Castle BBS (SysOp: Prophet)
  350.   818-240-9102 or 818-240-0318
  351.  
  352.   Daggerfall Ruins BBS (SysOp: Etherius)
  353.   213-726-3010
  354.  
  355. You can email me (Prophet) at any time with any questions/comments/troubles
  356. you may have.  Some places I can be reached at are:
  357.  
  358.   gcd@netcom.com   (Internet)
  359.   85:805/117       (ITCnet)
  360.   1:102/854        (FIDOnet)
  361.  
  362. The latest version of SyncChat can be found at the above two BBSs.  It can be
  363. downloaded directly from the Matrix Logon so you can minimize your time
  364. online and not kill your phone bill. ;)
  365. In addition, you can FREQ the latest version with the magic name "SYNCCHAT"
  366. from the following addresses:
  367.  
  368. 85:805/117 (ITCnet)    SysOp: Garry Dolley (me!)
  369. 85:85/0    (ITCnet)    SysOp: Jack Reece
  370. 1:102/854  (FIDOnet)   SysOp: Garry Dolley
  371. 1:102/835  (FIDOnet)   SysOp: Jack Reece
  372. 1:2201/11  (FIDOnet)   SysOp: Bill Cronkhite
  373.  
  374. I'd really like to hear from some of you who use this program.  Let me know
  375. what you think about it!  Also, if you find a bug, report it promptly, and I
  376. will fix it!  Thanks!
  377.  
  378. -Prophet
  379.  
  380.  
  381.  
  382.  
  383.